<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FreeRTOS Addons: src/mutex.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">FreeRTOS Addons
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">mutex.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/****************************************************************************</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> *</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *  Copyright (c) 2017, Michael Becker (michael.f.becker@gmail.com)</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> *  This file is part of the FreeRTOS Add-ons project.</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> *</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> *  Source Code:</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *  https://github.com/michaelbecker/freertos-addons</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *  Project Page:</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> *  http://michaelbecker.github.io/freertos-addons/</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> *</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> *  On-line Documentation:</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> *  http://michaelbecker.github.io/freertos-addons/docs/html/index.html</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> *</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> *  copy of this software and associated documentation files</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> *  (the &quot;Software&quot;), to deal in the Software without restriction, including</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> *  without limitation the rights to use, copy, modify, merge, publish,</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment"> *  distribute, sublicense, and/or sell copies of the Software, and to</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment"> *  permit persons to whom the Software is furnished to do so,subject to the</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment"> *  following conditions:</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment"> *</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment"> *  + The above copyright notice and this permission notice shall be included</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment"> *    in all copies or substantial portions of the Software.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"> *  + Credit is appreciated, but not required, if you find this project</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment"> *    useful enough to include in your application, product, device, etc.</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> *</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> *  THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> *  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> *  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> *  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> *  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> *  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> *</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> ***************************************************************************/</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="preprocessor">#include &quot;freertos-config.h&quot;</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="preprocessor">#ifndef MUTEX_HPP_</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="preprocessor">#define MUTEX_HPP_</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="preprocessor">#ifndef CPP_FREERTOS_NO_EXCEPTIONS</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="preprocessor">#include &lt;exception&gt;</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="preprocessor">#include &lt;cstdio&gt;</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">#ifdef CPP_FREERTOS_NO_CPP_STRINGS</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="preprocessor">#error &quot;FreeRTOS-Addons require C++ Strings if you are using exceptions&quot;</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="preprocessor">#include &quot;FreeRTOS.h&quot;</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="preprocessor">#include &quot;semphr.h&quot;</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacecpp__freertos.html">cpp_freertos</a> {</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="preprocessor">#ifndef CPP_FREERTOS_NO_EXCEPTIONS</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_mutex_create_exception.html">   70</a></span><span class="keyword">class </span><a class="code hl_class" href="classcpp__freertos_1_1_mutex_create_exception.html">MutexCreateException</a> : <span class="keyword">public</span> std::exception {</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>    <span class="keyword">public</span>:</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_mutex_create_exception.html#a1f0d4d2f54e54a7213b4e0518da9ca70">   76</a></span>        <a class="code hl_function" href="classcpp__freertos_1_1_mutex_create_exception.html#a1f0d4d2f54e54a7213b4e0518da9ca70">MutexCreateException</a>()</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>        {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>            sprintf(errorString, <span class="stringliteral">&quot;Mutex Constructor Failed&quot;</span>);</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>        }</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_mutex_create_exception.html#a34029763d883f085d7628cb6de272079">   85</a></span>        <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_function" href="classcpp__freertos_1_1_mutex_create_exception.html#a34029763d883f085d7628cb6de272079">what</a>() <span class="keyword">const</span> throw()</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>        {</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>            <span class="keywordflow">return</span> errorString;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>        }</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>    <span class="keyword">private</span>:</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>        <span class="keywordtype">char</span> errorString[80];</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>};</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_mutex.html">  109</a></span><span class="keyword">class </span><a class="code hl_class" href="classcpp__freertos_1_1_mutex.html">Mutex</a> {</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>    <span class="comment">//  Public API</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"></span>    <span class="keyword">public</span>:</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_mutex.html#ad32b3657e5bab97b248273e80c0c3ae7">  126</a></span>        <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcpp__freertos_1_1_mutex.html#ad32b3657e5bab97b248273e80c0c3ae7">Lock</a>(TickType_t Timeout = portMAX_DELAY) = 0;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span> </div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_mutex.html#a9acd81676fcd099254ecca161d51a4a3">  134</a></span>        <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcpp__freertos_1_1_mutex.html#a9acd81676fcd099254ecca161d51a4a3">Unlock</a>() = 0;</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>        <span class="keyword">virtual</span> <a class="code hl_function" href="classcpp__freertos_1_1_mutex.html#ac9e9182407f5f74892318607888e9be4">~Mutex</a>();</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span> </div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span>    <span class="comment">//  Protected API</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>    <span class="comment">//  Not intended for use by application code.</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"></span>    <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_mutex.html#a639327163cdbee7b3847982d49b2fe03">  151</a></span>        SemaphoreHandle_t <a class="code hl_variable" href="classcpp__freertos_1_1_mutex.html#a639327163cdbee7b3847982d49b2fe03">handle</a>;</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span> </div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span>        <a class="code hl_function" href="classcpp__freertos_1_1_mutex.html#a593423d868daf926c7b0d63a833ae29a">Mutex</a>();</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span>};</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span> </div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span> </div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_mutex_standard.html">  171</a></span><span class="keyword">class </span><a class="code hl_class" href="classcpp__freertos_1_1_mutex_standard.html">MutexStandard</a> : <span class="keyword">public</span> <a class="code hl_class" href="classcpp__freertos_1_1_mutex.html">Mutex</a> {</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span> </div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span>    <span class="comment">//  Public API</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"></span>    <span class="keyword">public</span>:</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span>        <a class="code hl_function" href="classcpp__freertos_1_1_mutex_standard.html#aa42d0a64a53ce605d519f87d46fc6d9d">MutexStandard</a>();</div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span> </div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span>        <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcpp__freertos_1_1_mutex_standard.html#a496a92f219f93f431a9249ba5d140a61">Lock</a>(TickType_t Timeout = portMAX_DELAY);</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span> </div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span>        <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcpp__freertos_1_1_mutex_standard.html#ac035aaf9134b1be0f03aa748b0e3b289">Unlock</a>();</div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span>};</div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span> </div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span> </div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="preprocessor">#if (configUSE_RECURSIVE_MUTEXES == 1)</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span> </div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_mutex_recursive.html">  219</a></span><span class="keyword">class </span><a class="code hl_class" href="classcpp__freertos_1_1_mutex_recursive.html">MutexRecursive</a> : <span class="keyword">public</span> <a class="code hl_class" href="classcpp__freertos_1_1_mutex.html">Mutex</a> {</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span> </div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span>    <span class="comment">//  Public API</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment"></span>    <span class="keyword">public</span>:</div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span>        <a class="code hl_function" href="classcpp__freertos_1_1_mutex_recursive.html#a426901660c5879b1c0a98f040be36b2f">MutexRecursive</a>();</div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span> </div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span>        <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcpp__freertos_1_1_mutex_recursive.html#a751e5af8f8af53de3822cc7c0f2c905e">Lock</a>(TickType_t Timeout = portMAX_DELAY);</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span> </div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span>        <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcpp__freertos_1_1_mutex_recursive.html#a99fa48374855689b546d4034fb458321">Unlock</a>();</div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span>};</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span> </div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span> </div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span> </div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_lock_guard.html">  264</a></span><span class="keyword">class </span><a class="code hl_class" href="classcpp__freertos_1_1_lock_guard.html">LockGuard</a> {</div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span> </div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span>    <span class="comment">//  Public API</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment"></span>    <span class="keyword">public</span>:</div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span>        <span class="keyword">explicit</span> <a class="code hl_class" href="classcpp__freertos_1_1_lock_guard.html">LockGuard</a>(<a class="code hl_class" href="classcpp__freertos_1_1_mutex.html">Mutex</a>&amp; m);</div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span> </div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span>        <a class="code hl_function" href="classcpp__freertos_1_1_lock_guard.html#acf9fd2e90ecd3b193b6292989a644c2c">~LockGuard</a>();</div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span> </div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span>        <span class="comment">//</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span>        <span class="comment">//  Private API</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span>        <span class="comment">//</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment"></span>    <span class="keyword">private</span>:</div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span>        <a class="code hl_class" href="classcpp__freertos_1_1_lock_guard.html">LockGuard</a>(<span class="keyword">const</span> <a class="code hl_class" href="classcpp__freertos_1_1_lock_guard.html">LockGuard</a>&amp;);</div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span> </div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span>        <a class="code hl_class" href="classcpp__freertos_1_1_mutex.html">Mutex</a>&amp; mutex;</div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span>};</div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span> </div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span> </div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span>}</div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclasscpp__freertos_1_1_lock_guard_html"><div class="ttname"><a href="classcpp__freertos_1_1_lock_guard.html">cpp_freertos::LockGuard</a></div><div class="ttdef"><b>Definition:</b> mutex.hpp:264</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_lock_guard_html_acf9fd2e90ecd3b193b6292989a644c2c"><div class="ttname"><a href="classcpp__freertos_1_1_lock_guard.html#acf9fd2e90ecd3b193b6292989a644c2c">cpp_freertos::LockGuard::~LockGuard</a></div><div class="ttdeci">~LockGuard()</div><div class="ttdef"><b>Definition:</b> cmutex.cpp:124</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_create_exception_html"><div class="ttname"><a href="classcpp__freertos_1_1_mutex_create_exception.html">cpp_freertos::MutexCreateException</a></div><div class="ttdef"><b>Definition:</b> mutex.hpp:70</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_create_exception_html_a1f0d4d2f54e54a7213b4e0518da9ca70"><div class="ttname"><a href="classcpp__freertos_1_1_mutex_create_exception.html#a1f0d4d2f54e54a7213b4e0518da9ca70">cpp_freertos::MutexCreateException::MutexCreateException</a></div><div class="ttdeci">MutexCreateException()</div><div class="ttdef"><b>Definition:</b> mutex.hpp:76</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_create_exception_html_a34029763d883f085d7628cb6de272079"><div class="ttname"><a href="classcpp__freertos_1_1_mutex_create_exception.html#a34029763d883f085d7628cb6de272079">cpp_freertos::MutexCreateException::what</a></div><div class="ttdeci">virtual const char * what() const</div><div class="ttdef"><b>Definition:</b> mutex.hpp:85</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_html"><div class="ttname"><a href="classcpp__freertos_1_1_mutex.html">cpp_freertos::Mutex</a></div><div class="ttdef"><b>Definition:</b> mutex.hpp:109</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_html_a593423d868daf926c7b0d63a833ae29a"><div class="ttname"><a href="classcpp__freertos_1_1_mutex.html#a593423d868daf926c7b0d63a833ae29a">cpp_freertos::Mutex::Mutex</a></div><div class="ttdeci">Mutex()</div><div class="ttdef"><b>Definition:</b> cmutex.cpp:46</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_html_a639327163cdbee7b3847982d49b2fe03"><div class="ttname"><a href="classcpp__freertos_1_1_mutex.html#a639327163cdbee7b3847982d49b2fe03">cpp_freertos::Mutex::handle</a></div><div class="ttdeci">SemaphoreHandle_t handle</div><div class="ttdef"><b>Definition:</b> mutex.hpp:151</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_html_a9acd81676fcd099254ecca161d51a4a3"><div class="ttname"><a href="classcpp__freertos_1_1_mutex.html#a9acd81676fcd099254ecca161d51a4a3">cpp_freertos::Mutex::Unlock</a></div><div class="ttdeci">virtual bool Unlock()=0</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_html_ac9e9182407f5f74892318607888e9be4"><div class="ttname"><a href="classcpp__freertos_1_1_mutex.html#ac9e9182407f5f74892318607888e9be4">cpp_freertos::Mutex::~Mutex</a></div><div class="ttdeci">virtual ~Mutex()</div><div class="ttdef"><b>Definition:</b> cmutex.cpp:51</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_html_ad32b3657e5bab97b248273e80c0c3ae7"><div class="ttname"><a href="classcpp__freertos_1_1_mutex.html#ad32b3657e5bab97b248273e80c0c3ae7">cpp_freertos::Mutex::Lock</a></div><div class="ttdeci">virtual bool Lock(TickType_t Timeout=portMAX_DELAY)=0</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_recursive_html"><div class="ttname"><a href="classcpp__freertos_1_1_mutex_recursive.html">cpp_freertos::MutexRecursive</a></div><div class="ttdef"><b>Definition:</b> mutex.hpp:219</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_recursive_html_a426901660c5879b1c0a98f040be36b2f"><div class="ttname"><a href="classcpp__freertos_1_1_mutex_recursive.html#a426901660c5879b1c0a98f040be36b2f">cpp_freertos::MutexRecursive::MutexRecursive</a></div><div class="ttdeci">MutexRecursive()</div><div class="ttdef"><b>Definition:</b> cmutex.cpp:87</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_recursive_html_a751e5af8f8af53de3822cc7c0f2c905e"><div class="ttname"><a href="classcpp__freertos_1_1_mutex_recursive.html#a751e5af8f8af53de3822cc7c0f2c905e">cpp_freertos::MutexRecursive::Lock</a></div><div class="ttdeci">virtual bool Lock(TickType_t Timeout=portMAX_DELAY)</div><div class="ttdef"><b>Definition:</b> cmutex.cpp:101</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_recursive_html_a99fa48374855689b546d4034fb458321"><div class="ttname"><a href="classcpp__freertos_1_1_mutex_recursive.html#a99fa48374855689b546d4034fb458321">cpp_freertos::MutexRecursive::Unlock</a></div><div class="ttdeci">virtual bool Unlock()</div><div class="ttdef"><b>Definition:</b> cmutex.cpp:108</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_standard_html"><div class="ttname"><a href="classcpp__freertos_1_1_mutex_standard.html">cpp_freertos::MutexStandard</a></div><div class="ttdef"><b>Definition:</b> mutex.hpp:171</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_standard_html_a496a92f219f93f431a9249ba5d140a61"><div class="ttname"><a href="classcpp__freertos_1_1_mutex_standard.html#a496a92f219f93f431a9249ba5d140a61">cpp_freertos::MutexStandard::Lock</a></div><div class="ttdeci">virtual bool Lock(TickType_t Timeout=portMAX_DELAY)</div><div class="ttdef"><b>Definition:</b> cmutex.cpp:71</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_standard_html_aa42d0a64a53ce605d519f87d46fc6d9d"><div class="ttname"><a href="classcpp__freertos_1_1_mutex_standard.html#aa42d0a64a53ce605d519f87d46fc6d9d">cpp_freertos::MutexStandard::MutexStandard</a></div><div class="ttdeci">MutexStandard()</div><div class="ttdef"><b>Definition:</b> cmutex.cpp:57</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_mutex_standard_html_ac035aaf9134b1be0f03aa748b0e3b289"><div class="ttname"><a href="classcpp__freertos_1_1_mutex_standard.html#ac035aaf9134b1be0f03aa748b0e3b289">cpp_freertos::MutexStandard::Unlock</a></div><div class="ttdeci">virtual bool Unlock()</div><div class="ttdef"><b>Definition:</b> cmutex.cpp:78</div></div>
<div class="ttc" id="anamespacecpp__freertos_html"><div class="ttname"><a href="namespacecpp__freertos.html">cpp_freertos</a></div><div class="ttdef"><b>Definition:</b> condition_variable.hpp:57</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
